Audience Segment
Create multiple audience segments
Creates multiple audience segments in a single operation.
Limited to 1000 audience segments per request.
POST
/
audiences
/
segments
/
bulk-add
Create multiple audience segments
curl --request POST \
--url https://your_a2_service/audiences/segments/bulk-add \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "<string>",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"approximated_size": 123,
"created_at": "2023-11-07T05:31:56Z",
"deprecated_properties": {},
"description": "<string>",
"properties": {},
"updated_at": "2023-11-07T05:31:56Z"
}
]
'import requests
url = "https://your_a2_service/audiences/segments/bulk-add"
payload = [
{
"name": "<string>",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"approximated_size": 123,
"created_at": "2023-11-07T05:31:56Z",
"deprecated_properties": {},
"description": "<string>",
"properties": {},
"updated_at": "2023-11-07T05:31:56Z"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
name: '<string>',
owner_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
approximated_size: 123,
created_at: '2023-11-07T05:31:56Z',
deprecated_properties: {},
description: '<string>',
properties: {},
updated_at: '2023-11-07T05:31:56Z'
}
])
};
fetch('https://your_a2_service/audiences/segments/bulk-add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your_a2_service/audiences/segments/bulk-add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'name' => '<string>',
'owner_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'approximated_size' => 123,
'created_at' => '2023-11-07T05:31:56Z',
'deprecated_properties' => [
],
'description' => '<string>',
'properties' => [
],
'updated_at' => '2023-11-07T05:31:56Z'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your_a2_service/audiences/segments/bulk-add"
payload := strings.NewReader("[\n {\n \"name\": \"<string>\",\n \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"approximated_size\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"deprecated_properties\": {},\n \"description\": \"<string>\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your_a2_service/audiences/segments/bulk-add")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"name\": \"<string>\",\n \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"approximated_size\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"deprecated_properties\": {},\n \"description\": \"<string>\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_a2_service/audiences/segments/bulk-add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"name\": \"<string>\",\n \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"approximated_size\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"deprecated_properties\": {},\n \"description\": \"<string>\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n }\n]"
response = http.request(request)
puts response.read_body{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
The management type of the audience segment
Available options:
selfmanaged, systemmanaged Name of the audience segment
Owner ID of the audience segment
Approximated size of the audience segment.
The date and time the entity was created.
Deprecated properties for the audience segment.
Show child attributes
Show child attributes
Description of the audience segment
Properties for the audience segment.
The key is AudienceAttribute.code, and the value can be a list of AudienceAttributeValue.value
Show child attributes
Show child attributes
The date and time the entity was last updated.
Response
Successful Response
Was this page helpful?
⌘I
Create multiple audience segments
curl --request POST \
--url https://your_a2_service/audiences/segments/bulk-add \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "<string>",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"approximated_size": 123,
"created_at": "2023-11-07T05:31:56Z",
"deprecated_properties": {},
"description": "<string>",
"properties": {},
"updated_at": "2023-11-07T05:31:56Z"
}
]
'import requests
url = "https://your_a2_service/audiences/segments/bulk-add"
payload = [
{
"name": "<string>",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"approximated_size": 123,
"created_at": "2023-11-07T05:31:56Z",
"deprecated_properties": {},
"description": "<string>",
"properties": {},
"updated_at": "2023-11-07T05:31:56Z"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
name: '<string>',
owner_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
approximated_size: 123,
created_at: '2023-11-07T05:31:56Z',
deprecated_properties: {},
description: '<string>',
properties: {},
updated_at: '2023-11-07T05:31:56Z'
}
])
};
fetch('https://your_a2_service/audiences/segments/bulk-add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your_a2_service/audiences/segments/bulk-add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'name' => '<string>',
'owner_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'approximated_size' => 123,
'created_at' => '2023-11-07T05:31:56Z',
'deprecated_properties' => [
],
'description' => '<string>',
'properties' => [
],
'updated_at' => '2023-11-07T05:31:56Z'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your_a2_service/audiences/segments/bulk-add"
payload := strings.NewReader("[\n {\n \"name\": \"<string>\",\n \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"approximated_size\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"deprecated_properties\": {},\n \"description\": \"<string>\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your_a2_service/audiences/segments/bulk-add")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"name\": \"<string>\",\n \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"approximated_size\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"deprecated_properties\": {},\n \"description\": \"<string>\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_a2_service/audiences/segments/bulk-add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"name\": \"<string>\",\n \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"approximated_size\": 123,\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"deprecated_properties\": {},\n \"description\": \"<string>\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n }\n]"
response = http.request(request)
puts response.read_body{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}